Docs for /metrics endpoint #2024
Open
+6
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
codebien
commented
Aug 8, 2025
| * [pprof](https://pkg.go.dev/net/http/pprof) profiling endpoints for CPU and memory profiling | ||
| * Prometheus [/metrics](https://prometheus.io/docs/guides/go-application/#how-go-exposition-works) endpoint for exporting Go runtime metrics | ||
|
|
||
| The k6 REST API must be enabled for these endpoints to be available (this is the default behavior). |
There was a problem hiding this comment.
This was already added before, but I haven't found the documentation about how to disable the API. Do we really support it?
There was a problem hiding this comment.
You can set it to an empty string and it will be disabled.
There was a problem hiding this comment.
I will try to submit some docs for it as soon as possible tomorrow.
mstoykov
approved these changes
Aug 11, 2025
| * [pprof](https://pkg.go.dev/net/http/pprof) profiling endpoints for CPU and memory profiling | ||
| * Prometheus [/metrics](https://prometheus.io/docs/guides/go-application/#how-go-exposition-works) endpoint for exporting Go runtime metrics | ||
|
|
||
| The k6 REST API must be enabled for these endpoints to be available (this is the default behavior). |
There was a problem hiding this comment.
You can set it to an empty string and it will be disabled.
|
I would also recommend amending, if necessary, our versioning and support policy to explicit mention we do not officially support nor provide any guarantees around those endpoints as they are essentially external dependencies out of our control 🙇🏻 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
It adds documentation for the new endpoint
/metricsadded when the option--profiling-enabled. The pull request with the implementation grafana/k6#4944.Checklist
npm startcommand locally and verified that the changes look good.docs/sources/k6/nextfolder of the documentation.Related PR(s)/Issue(s)